Document the "set-scroll-adjustments" signal

2008-12-11  Sven Herzberg  <sven@imendio.com>

	Document the "set-scroll-adjustments" signal

	Reviewed by Kristian Rietveld.

	* gtk/gtkiconview.c,
	* gtk/gtklayout.c,
	* gtk/gtktextview.c,
	* gtk/gtktreeview.c,
	* gtk/gtkviewport.c: added proper documentation for the signal

svn path=/trunk/; revision=21871

diff --git a/ChangeLog b/ChangeLog
index 37a0233a9b301420cf77be348dd83381926afd3b..ee268696a826a298202087e78fcf4fce389479fb 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2008-12-11  Sven Herzberg  <sven@imendio.com>
+
+       Document the "set-scroll-adjustments" signal
+
+       Reviewed by Kristian Rietveld.
+
+       * gtk/gtkiconview.c,
+       * gtk/gtklayout.c,
+       * gtk/gtktextview.c,
+       * gtk/gtktreeview.c,
+       * gtk/gtkviewport.c: added proper documentation for the signal
+
 2008-12-11  Daniel Elstner  <danielk@openismus.com>
 
        Bug 563994 – Input method module interface not documented

diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c
index b5157c4e4874565cbbb60c89465a053441e18159..05ad6b5a6a592dfff54e851522d8297543527c65 100644 (file)
--- a/gtk/gtkiconview.c
+++ b/gtk/gtkiconview.c
@@ -777,6 +777,15 @@ gtk_icon_view_class_init (GtkIconViewClass *klass)
                                                                GTK_PARAM_READABLE));
 
   /* Signals */
+  /**
+   * GtkIconView::set-scroll-adjustments
+   * @horizontal: the horizontal #GtkAdjustment
+   * @vertical: the vertical #GtkAdjustment
+   *
+   * Set the scroll adjustments for the icon view. Usually scrolled containers
+   * like #GtkScrolledWindow will emit this signal to connect two instances
+   * of #GtkScrollbar to the scroll directions of the #GtkIconView.
+   */
   widget_class->set_scroll_adjustments_signal =
     g_signal_new (I_("set-scroll-adjustments"),
                  G_TYPE_FROM_CLASS (gobject_class),

diff --git a/gtk/gtklayout.c b/gtk/gtklayout.c
index ccd8ede6bf23f54585beaf776c6f16a51ce64fe8..153a2dfca437d452783573dc4fc9be5aee00d159 100644 (file)
--- a/gtk/gtklayout.c
+++ b/gtk/gtklayout.c
@@ -658,6 +658,15 @@ gtk_layout_class_init (GtkLayoutClass *class)
 
   class->set_scroll_adjustments = gtk_layout_set_adjustments;
 
+  /**
+   * GtkLayout::set-scroll-adjustments
+   * @horizontal: the horizontal #GtkAdjustment
+   * @vertical: the vertical #GtkAdjustment
+   *
+   * Set the scroll adjustments for the layout. Usually scrolled containers
+   * like #GtkScrolledWindow will emit this signal to connect two instances
+   * of #GtkScrollbar to the scroll directions of the #GtkLayout.
+   */
   widget_class->set_scroll_adjustments_signal =
     g_signal_new (I_("set-scroll-adjustments"),
                  G_OBJECT_CLASS_TYPE (gobject_class),

diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c
index 9af93c89de7831a59ff320575e8b3a2d5736baa1..a45b390f5a51d086f66dc68eaf86ece6418e589b 100644 (file)
--- a/gtk/gtktextview.c
+++ b/gtk/gtktextview.c
@@ -913,6 +913,15 @@ gtk_text_view_class_init (GtkTextViewClass *klass)
                  _gtk_marshal_VOID__VOID,
                  G_TYPE_NONE, 0);
 
+  /**
+   * GtkTextView::set-scroll-adjustments
+   * @horizontal: the horizontal #GtkAdjustment
+   * @vertical: the vertical #GtkAdjustment
+   *
+   * Set the scroll adjustments for the text view. Usually scrolled containers
+   * like #GtkScrolledWindow will emit this signal to connect two instances
+   * of #GtkScrollbar to the scroll directions of the #GtkTextView.
+   */
   signals[SET_SCROLL_ADJUSTMENTS] =
     g_signal_new (I_("set-scroll-adjustments"),
                  G_OBJECT_CLASS_TYPE (gobject_class),

diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c
index bff4ae851b91b0b8c5e1dd90607dc66f9366f116..703f07935d7a4073510904715638bd20a4bd11c9 100644 (file)
--- a/gtk/gtktreeview.c
+++ b/gtk/gtktreeview.c
@@ -869,6 +869,15 @@ gtk_tree_view_class_init (GtkTreeViewClass *class)
                                                                GTK_PARAM_READABLE));
 
   /* Signals */
+  /**
+   * GtkTreeView::set-scroll-adjustments
+   * @horizontal: the horizontal #GtkAdjustment
+   * @vertical: the vertical #GtkAdjustment
+   *
+   * Set the scroll adjustments for the tree view. Usually scrolled containers
+   * like #GtkScrolledWindow will emit this signal to connect two instances
+   * of #GtkScrollbar to the scroll directions of the #GtkTreeView.
+   */
   widget_class->set_scroll_adjustments_signal =
     g_signal_new (I_("set-scroll-adjustments"),
                  G_TYPE_FROM_CLASS (o_class),

diff --git a/gtk/gtkviewport.c b/gtk/gtkviewport.c
index ad5a310441769cf2891def7e96a525c3adafae64..3e64564611e3656180b37e2af24e27fed4f0c5be 100644 (file)
--- a/gtk/gtkviewport.c
+++ b/gtk/gtkviewport.c
@@ -125,6 +125,15 @@ gtk_viewport_class_init (GtkViewportClass *class)
                                                      GTK_SHADOW_IN,
                                                      GTK_PARAM_READWRITE));
 
+  /**
+   * GtkViewport::set-scroll-adjustments
+   * @horizontal: the horizontal #GtkAdjustment
+   * @vertical: the vertical #GtkAdjustment
+   *
+   * Set the scroll adjustments for the viewport. Usually scrolled containers
+   * like #GtkScrolledWindow will emit this signal to connect two instances
+   * of #GtkScrollbar to the scroll directions of the #GtkViewport.
+   */
   widget_class->set_scroll_adjustments_signal =
     g_signal_new (I_("set-scroll-adjustments"),
                  G_OBJECT_CLASS_TYPE (gobject_class),